Macros

 

Macros, by definition, are a series of commands that are assigned to a single keystroke.  They are designed to help you perform tasks that are frequently repeated.  Here, macros are a command or a series of commands that are tied to one of the function keys (F2 through F12 [excluding F1]).  Each function key can be used either alone, or with the Alt, Shift or Ctrl keys.  This allows you many specific keys which you can customize to your liking.  Once a command or series of commands have been assigned to a macro, pressing the appropriate function key will invoke the command(s) just as if you typed them out yourself.  This can be especially handy when you have a long list of commands to remember, like directions to a particular area for example.

 

Note: While F1 is not available (it’s used for the help topics), Alt+F1, Shift+F1 and Ctrl+F1 are still available.

 

You are also given the number keys on the number pad for macro availability as well.  These keys include Numpad0 through Numpad9, as well as NumpadD (the number pad decimal point key) Numpad/, Numpad*, Numpad- and Numpad+.   See the section on using macros below for the default values associated with these keys.

 

Note: You can only use the number pad macros when then Num Lock status of your keyboard is engaged.

 

Macros can be invoked from any command, anywhere (not just the function keys).  If the command is identical to the macro name (case sensitive), that macro will be fired.  For example, if an event action called “F2” as a command, the event action will, in turn, fire off the commands associated with the macro “F2.”

 

Macros Screen Elements

 

 

Macros Grid

This grid displays all macros that are available for you to customize.  Use the mouse or arrow keys to select the macro you desire.  If any macros have commands assigned to them, they will appear in this grid with a silver background.

 

Macro Script

This script displays all commands assigned to the macro currently selected in the grid.  If the script is empty, there are no commands currently assigned to that macro.  You can freely edit as you like in this field.  Each individual line will be read as an individual command when the macro is executed.

 

Script Buttons

Undo Undo Undoes any changes recently made to the script
 A/M Alias/Macro grabber Insert an alias or macro
 f(x) Function grabber Insert a function into the script
 @ Variable grabber Insert a specific variable into the script
 Eraser Clear script Clears the entire script

 

Note: You can enter comments/remarks into scripts by using the letters "REM" (all must be uppercase) as the first three characters in the command.  This basically tells Portal© to completely ignore that line.

 

Special Macros Matrix

This area lists the special macros.  If any are assigned, they are color coded to their appropriate macro in both the Macros Grid and the Key Mapping Buttons.  Use the Set buttons to set the currently selected macro as the desired macro (Login, Panic or Unpanic).

 

Key Mapping Buttons

Press any one of these keys to select that particular macro and display any commands currently assigned to it.  If a key’s associated macro has any commands assigned, the button label will appear in bold white.

 

Close Button

Closes the Macros Screen.

 

Using Macros

 

As described above, macros can be wonderful tools in helping you perform many tasks with the click of only one button.  Use the following list of points to help you understand exactly how they work.

 

Macros are engaged immediately

Unlike aliases, macros are sent the moment the function key is pressed.  This means that you don't have to hit return after pressing the macro key.

 

The control macros are assigned to the macro buttons on the Toolbars

These buttons can be configured to appear on the Toolbars (they don’t appear by default).  The buttons appear as a large yellow “M” with a small black number in front of it.  The number identifies the function key the button is connected to.  For example, the button with the “2” on it is assigned to the macro contained in Ctrl+F2.  Some people like hitting the Ctrl+F2 buttons on the keyboard, others like clicking the toolbar buttons with the mouse.  It’s up to you, both activate the same macro.

 

Macros can have delays between commands

Sometimes it is not desirable to have all commands in a macro fire off all at once.  In these cases, you can insert a delay of up to 99 seconds between commands.  To insert a delay, simply type the word “wait” followed by the number of seconds of delay.  For example: “wait 2” as the 2nd command would mean that the 1st command would fire off, then there would be a 2 second delay, then the 3rd command would be invoked.

 

You can also insert a random delay between commands using the “rwait” command. The format for using rwait is exactly like the format for wait, save that the delay will be a random number from 0 to the number given.  Using the above example, if you used “rwait 5” the 1st command would fire off, then there would be a random delay of anywhere from 0 to 5 seconds, then the 3rd command would be invoked.

 

Note: The delay is randomized every time the macro is used.

 

The number pad macros are set to the following combinations as default

Of course you can change them, just as you could any other macro, we simply provided these using the most popular template.

 

Macro                     Command

Numpad8                move north (n)

Numpad9                move northeast (ne)

Numpad6                move east (e)

Numpad3                move southeast (se)

Numpad2                move south (s)

Numpad1                move southwest (sw)

Numpad4                move west (w)

Numpad7                move northwest (nw)

NumpadD                move up (u)

Numpad0                move down (d)

Numpad5                ;look;search (look & search, used as parsed commands)

Numpad/                 not set

Numpad*                 not set

Numpad-                 not set

Numpad+                not set